ScxV6Area.Name Method
Gets or sets the name of the Area of Interest
Parameters
- Name
The name of the Area of Interest.
Remarks
The operation may fail if:
- An existing Area of Interest with the same name already exists in the parent area of the Area of Interest.
- The name contains invalid characters, for example a full stop.
The following example written in Visual Basic shows the Name property being used change the name of an area of interest.
Dim Svr As ScxV6DbClient.ScxV6Server
Dim Areas As ScxV6DbClient.ScxV6Areas
' Connect to the server
Svr = New ScxV6DbClient.ScxV6Server()
Svr.Connect("MAIN", "", "")
' Find the area of interest we want to change the name of
Areas = Svr.RootArea.List
For Each Area As ScxV6DbClient.ScxV6Area In Areas
If Area.Name = "Area 1" Then
Area.Name = "Area 2"
Exit For
End If
Next
' Disconnect
Svr.Disconnect()